| Visual Basic (Declaration) | |
|---|---|
Public Overloads Overrides Function Read( _ ByVal buffer() As Byte, _ ByVal offset As Integer, _ ByVal count As Integer _ ) As Integer | |
| Visual Basic (Usage) | Copy Code |
|---|---|
Dim instance As SegmentedStream Dim buffer() As Byte Dim offset As Integer Dim count As Integer Dim value As Integer value = instance.Read(buffer, offset, count) | |
Parameters
- buffer
- The storage location for the received data.
- offset
- The zero-based position in the buffer at which to store the received data.
- count
- The maximum number of bytes to read.
Return Value
The total number of bytes read into the buffer.| Exception | Description |
|---|---|
| System.IO.IOException | Thrown when the stream is not Readable. |
| System.ArgumentNullException | Thrown when the receiving buffer is null. |
| System.ArgumentOutOfRangeException | Thrown when the offset is less than zero or when count is less than or equal to zero. |
| System.ArgumentException | Thrown when the (offset + count) > buffer.Length. |
This method will block (for ReceiveTimeout) until at least 1 byte is available for reading, or the connection is closed by the server, in which case an empty string is returned. The Charset property is used to convert from bytes to unicode characters, which allows unicode characters to be passed over the network.
The value returned may be less than the number of bytes requested if that many bytes are not currently available, or zero if the end of the stream has been reached. Applications must check this value to know how many bytes were read into the buffer.
Target Platforms: Microsoft .NET Framework 2.0